<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.7.1">
<title>脚手架 后端REST接口文档</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Remove comment around @import statement below when using as a custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
[hidden],template{display:none}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
body{margin:0}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
body{-webkit-font-smoothing:antialiased}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.spread{width:100%}
p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.no-bullet{list-style:none}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite:before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7;font-weight:bold}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
body{tab-size:4}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
.clearfix:after,.float-group:after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menu{color:rgba(0,0,0,.8)}
b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
b.button:before{content:"[";padding:0 3px 0 2px}
b.button:after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
#header:after,#content:after,#footnotes:after,#footer:after{clear:both}
#content{margin-top:1.25em}
#content:before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span:before{content:"\00a0\2013\00a0"}
#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark:before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber:after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media only screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
.sect1{padding-bottom:.625em}
@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
.sect1+.sect1{border-top:1px solid #efefed}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.listingblock>.content{position:relative}
.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
.listingblock:hover code[data-lang]:before{display:block}
.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
table.pyhltable td.code{padding-left:.75em;padding-right:0}
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
pre.pygments .lineno{display:inline-block;margin-right:.25em}
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
.quoteblock .quoteblock blockquote:before{display:none}
.verseblock{margin:0 1em 1.25em 1em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract{margin:0 0 1.25em 0;display:block}
.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
table.tableblock{max-width:100%;border-collapse:separate}
table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot{border-width:1px 0}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
td>div.verse{white-space:pre}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
ul.inline>li>*{display:block}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
.colist>table tr>td:last-of-type{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background-color:#00fafa}
.black{color:#000}
.black-background{background-color:#000}
.blue{color:#0000bf}
.blue-background{background-color:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background-color:#fa00fa}
.gray{color:#606060}
.gray-background{background-color:#7d7d7d}
.green{color:#006000}
.green-background{background-color:#007d00}
.lime{color:#00bf00}
.lime-background{background-color:#00fa00}
.maroon{color:#600000}
.maroon-background{background-color:#7d0000}
.navy{color:#000060}
.navy-background{background-color:#00007d}
.olive{color:#606000}
.olive-background{background-color:#7d7d00}
.purple{color:#600060}
.purple-background{background-color:#7d007d}
.red{color:#bf0000}
.red-background{background-color:#fa0000}
.silver{color:#909090}
.silver-background{background-color:#bcbcbc}
.teal{color:#006060}
.teal-background{background-color:#007d7d}
.white{color:#bfbfbf}
.white-background{background-color:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background-color:#fafa00}
span.icon>.fa{cursor:default}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]:after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@media print{@page{margin:1.25cm .75cm}
*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]:after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
.sect1{padding-bottom:0!important}
.sect1+.sect1{border:0!important}
#header>h1:first-child{margin-top:1.25rem}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span:before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]:before{display:block}
#footer{background:none!important;padding:0 .9375em}
#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}

/* custom */
div.paragraph>p{text-indent: 2em; margin-bottom: .5em;}
ul, ol, ul.no-bullet, ol.no-bullet{margin-left: 3.5em;}
.imageblock>.title{text-align: center;}
table.tableblock>.title{text-align: center;}
/*code { text-decoration: line-through; }*/

</style>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
</head>
<body class="book toc2 toc-left">
<div id="header">
<h1>脚手架 后端REST接口文档</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel0">
<li><a href="#overview">Overview</a>
<ul class="sectlevel1">
<li><a href="#overview-changelogs">1. Change Logs</a></li>
<li><a href="#overview-general">2. General</a>
<ul class="sectlevel2">
<li><a href="#overview-http-verbs">2.1. HTTP verbs</a></li>
<li><a href="#overview-pagination">2.2. Pagination</a></li>
<li><a href="#_error_responses">2.3. Error Responses</a></li>
<li><a href="#_login_用户登录">2.4. Login 用户登录</a></li>
<li><a href="#_logout_用户登出">2.5. Logout 用户登出</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#_resources">Resources</a>
<ul class="sectlevel1">
<li><a href="#_attachment_附件上传下载">3. Attachment 附件上传下载</a>
<ul class="sectlevel2">
<li><a href="#resources-attachment-upload">3.1. Upload</a></li>
<li><a href="#resources-attachment-download">3.2. Download</a></li>
</ul>
</li>
<li><a href="#_self_个人信息管理">4. Self 个人信息管理</a>
<ul class="sectlevel2">
<li><a href="#resources-self-detail">4.1. Detail</a></li>
<li><a href="#resources-self-update">4.2. Update</a></li>
<li><a href="#resources-self-update-password">4.3. Update Password</a></li>
</ul>
</li>
<li><a href="#_dept_部门管理">5. Dept 部门管理</a>
<ul class="sectlevel2">
<li><a href="#resources-dept-all">5.1. List</a></li>
<li><a href="#resources-dept-create">5.2. Create</a></li>
<li><a href="#resources-dept-update">5.3. Update</a></li>
<li><a href="#resources-dept-toggle">5.4. Toggle</a></li>
</ul>
</li>
<li><a href="#_role_角色管理">6. Role 角色管理</a>
<ul class="sectlevel2">
<li><a href="#resources-role-all">6.1. List</a></li>
<li><a href="#resources-role-create">6.2. Create</a></li>
<li><a href="#resources-role-update">6.3. Update</a></li>
<li><a href="#resources-role-toggle">6.4. Toggle</a></li>
</ul>
</li>
<li><a href="#_user_用户管理">7. User 用户管理</a>
<ul class="sectlevel2">
<li><a href="#resources-user-query">7.1. Page</a></li>
<li><a href="#resources-user-create">7.2. Create</a></li>
<li><a href="#resources-user-update">7.3. Update</a></li>
<li><a href="#resources-user-update-password">7.4. Update Password</a></li>
<li><a href="#resources-user-toggle">7.5. Toggle</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<h1 id="overview" class="sect0"><a class="anchor" href="#overview"></a><a class="link" href="#overview">Overview</a></h1>
<div class="sect1">
<h2 id="overview-changelogs"><a class="anchor" href="#overview-changelogs"></a><a class="link" href="#overview-changelogs">1. Change Logs</a></h2>
<div class="sectionbody">

</div>
</div>
<div class="sect1">
<h2 id="overview-general"><a class="anchor" href="#overview-general"></a><a class="link" href="#overview-general">2. General</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="overview-http-verbs"><a class="anchor" href="#overview-http-verbs"></a><a class="link" href="#overview-http-verbs">2.1. HTTP verbs</a></h3>
<div class="paragraph">
<p>An example of static AsciiDoc.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Verb</th>
<th class="tableblock halign-left valign-top">Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to retrieve a resource (idempotent)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to create a new resource</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PUT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to update an existing resource (idempotent)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PATCH</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to update an existing resource</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DELETE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to delete an existing resource</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="overview-pagination"><a class="anchor" href="#overview-pagination"></a><a class="link" href="#overview-pagination">2.2. Pagination</a></h3>
<div class="paragraph">
<p>Spring pagination facilities offer following request parameters:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. Request parameters</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">page</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page you want to retrieve, 0 indexed and defaults to 0.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Size of the page you want to retrieve, defaults to 20.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sort</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Properties that should be sorted by in the format <code>property,property(,ASC|DESC)</code>.
Default sort direction is ascending. Use multiple sort parameters if you want to
switch directions, e.g. <code>?sort=firstname&amp;sort=lastname,asc</code>.</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>Pagination response has the following structure:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. Response structure</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Actual items.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">totalElements</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Total count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">totalPages</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Total pages with current page size.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">last</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If this page is the last one.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">numberOfElements</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Actual size of content array (number of items).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">first</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If this page is the first one.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">sort</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sort information object.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Requested size of the page.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">number</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page number.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_error_responses"><a class="anchor" href="#_error_responses"></a><a class="link" href="#_error_responses">2.3. Error Responses</a></h3>
<div class="sect3">
<h4 id="_global_http_return_codes"><a class="anchor" href="#_global_http_return_codes"></a><a class="link" href="#_global_http_return_codes">Global HTTP Return Codes</a></h4>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
200
</td>
<td class="hdlist2">
<p>操作成功</p>
</td>
</tr>
<tr>
<td class="hdlist1">
400
</td>
<td class="hdlist2">
<p>用户输入错误</p>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
包含 errors 对象
</td>
<td class="hdlist2">
<p>字段验证未通过, 提示用户修正输入</p>
</td>
</tr>
<tr>
<td class="hdlist1">
不包含 errors 对象
</td>
<td class="hdlist2">
<p>传入的数据类型出错, 可能因接口变动导致.</p>
</td>
</tr>
</table>
</div>
</td>
</tr>
<tr>
<td class="hdlist1">
401
</td>
<td class="hdlist2">
<p>用户未登录</p>
</td>
</tr>
<tr>
<td class="hdlist1">
403
</td>
<td class="hdlist2">
<p>接口无权</p>
</td>
</tr>
<tr>
<td class="hdlist1">
404
</td>
<td class="hdlist2">
<p>访问的对象不存在 或 接口不存在</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_login_用户登录"><a class="anchor" href="#_login_用户登录"></a><a class="link" href="#_login_用户登录">2.4. Login 用户登录</a></h3>
<div class="listingblock">
<div class="title">httpie-request</div>
<div class="content">
<pre class="highlight"><code>$ http --form POST 'http://localhost:8802/api/rest/user/login' \
    'Cookie:JSESSIONID=DC04209F02F39867C18A0093330000EF' \
    'username=sola' \
    'password=test' \
    'remember-me=true'</code></pre>
</div>
</div>
<div class="paragraph">
<p>this request won&#8217;t return any data.
if user authenticated successfully,
<code>200 OK</code> will be returned,
otherwise, will be <code>401 Unauthorized</code>
which means an error occurred during the authentication process.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Code</th>
<th class="tableblock halign-left valign-top">Result</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>200</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Success</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>401</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Wrong credentials</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>500</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Server internal error</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_logout_用户登出"><a class="anchor" href="#_logout_用户登出"></a><a class="link" href="#_logout_用户登出">2.5. Logout 用户登出</a></h3>
<div class="listingblock">
<div class="title">httpie-request</div>
<div class="content">
<pre class="highlight"><code>$ http --form POST 'http://localhost:8802/api/rest/user/logout' \
    'Cookie:JSESSIONID=DC04209F02F39867C18A0093330000EF' \</code></pre>
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Code</th>
<th class="tableblock halign-left valign-top">Result</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>200</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Success. Implementors should redirect the user to login page afterward.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>500</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Server internal error</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<h1 id="_resources" class="sect0"><a class="anchor" href="#_resources"></a><a class="link" href="#_resources">Resources</a></h1>
<div class="sect1">
<h2 id="_attachment_附件上传下载"><a class="anchor" href="#_attachment_附件上传下载"></a><a class="link" href="#_attachment_附件上传下载">3. Attachment 附件上传下载</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="resources-attachment-upload"><a class="anchor" href="#resources-attachment-upload"></a><a class="link" href="#resources-attachment-upload">3.1. Upload</a></h3>
<div class="paragraph">
<p><code>POST /api/rest/attachment</code></p>
</div>
<div class="paragraph">
<p>上传附件.</p>
</div>
<div class="sect3">
<h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a class="link" href="#_example_request">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http --form POST 'http://localhost:8080/api/rest/attachment' \
    'file'@&lt;(echo '"file"')</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body"><a class="anchor" href="#_response_body"></a><a class="link" href="#_response_body">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : "0a20a3f76a9f7137e647c8b094c8b38cc1b854a6",
  "filename" : "test.pdf",
  "mimeType" : "application/pdf",
  "type" : "其他",
  "uploadAt" : "2023-11-17T19:48:32.192204",
  "url" : "/api/rest/attachment/0a20a3f76a9f7137e647c8b094c8b38cc1b854a6"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_query_parameters"><a class="anchor" href="#_query_parameters"></a><a class="link" href="#_query_parameters">Query parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">附件功能类型.</p>
<p class="tableblock">Must be one of [其他, 头像].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">file</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">文件.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields"><a class="anchor" href="#_response_fields"></a><a class="link" href="#_response_fields">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID，用文件和文件名的SHA-1值生成.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">filename</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">文件名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">mimeType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">附件文件类型.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">附件功能类型.</p>
<p class="tableblock">Must be one of [其他, 头像].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">uploadAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">文件上传时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">url</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">文件下载链接.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-attachment-download"><a class="anchor" href="#resources-attachment-download"></a><a class="link" href="#resources-attachment-download">3.2. Download</a></h3>
<div class="paragraph">
<p><code>GET /api/rest/attachment/{id}</code></p>
</div>
<div class="paragraph">
<p>下载附件.</p>
</div>
<div class="sect3">
<h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a class="link" href="#_example_request_2">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http GET 'http://localhost:8080/api/rest/attachment/0a20a3f76a9f7137e647c8b094c8b38cc1b854a6'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_2"><a class="anchor" href="#_response_body_2"></a><a class="link" href="#_response_body_2">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code></code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters"><a class="anchor" href="#_path_parameters"></a><a class="link" href="#_path_parameters">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">附件ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_2"><a class="anchor" href="#_response_fields_2"></a><a class="link" href="#_response_fields_2">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">uri</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">filename</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">url</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">open</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">file</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">readable</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">inputStream</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_self_个人信息管理"><a class="anchor" href="#_self_个人信息管理"></a><a class="link" href="#_self_个人信息管理">4. Self 个人信息管理</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="resources-self-detail"><a class="anchor" href="#resources-self-detail"></a><a class="link" href="#resources-self-detail">4.1. Detail</a></h3>
<div class="paragraph">
<p><code>GET /api/rest/self</code></p>
</div>
<div class="paragraph">
<p>用户获取自己的详细信息.</p>
</div>
<div class="sect3">
<h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a class="link" href="#_example_request_3">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http GET 'http://localhost:8080/api/rest/self'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_3"><a class="anchor" href="#_response_body_3"></a><a class="link" href="#_response_body_3">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "remark" : "CbzIG",
  "createAt" : "2023-11-17T19:48:31.37127",
  "updateAt" : "2023-11-17T19:48:31.371277",
  "username" : "TNbOR",
  "name" : "cHyRV",
  "phone" : "13948807383",
  "email" : "7jJSZh5g@ZVoOqM.com",
  "avatar" : "umwInwYffsoKdMTfZmLeyScnrxSFayQfIrGdFcFw",
  "enableState" : "启用",
  "dept" : {
    "id" : "#",
    "parentId" : null,
    "name" : "总公司",
    "idPath" : null,
    "namePath" : null,
    "childIds" : null,
    "createAt" : "2023-11-17T19:48:31.371216",
    "updateAt" : "2023-11-17T19:48:31.371231",
    "type" : "总公司",
    "enableState" : "启用",
    "principal" : "TcJrB",
    "phone" : "139mQsET69H",
    "remark" : "YPypk"
  },
  "role" : {
    "id" : -1,
    "createAt" : "2023-11-17T19:48:31.37125",
    "updateAt" : "2023-11-17T19:48:31.371256",
    "name" : "系统管理员",
    "type" : "自定义",
    "dataScope" : "个人",
    "enableState" : "启用",
    "deptType" : "总公司",
    "authorities" : [ "DEPT_UPDATE", "ROLE_UPDATE", "DEPT_QUERY" ],
    "remark" : "SqWXU"
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_fields_3"><a class="anchor" href="#_response_fields_3"></a><a class="link" href="#_response_fields_3">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-self-update"><a class="anchor" href="#resources-self-update"></a><a class="link" href="#resources-self-update">4.2. Update</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/self</code></p>
</div>
<div class="paragraph">
<p>用户更新自己的信息.</p>
</div>
<div class="sect3">
<h4 id="_example_request_4"><a class="anchor" href="#_example_request_4"></a><a class="link" href="#_example_request_4">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"name":"cHyRV","phone":"13948807383","email":"7jJSZh5g@ZVoOqM.com","avatar":"umwInwYffsoKdMTfZmLeyScnrxSFayQfIrGdFcFw"}' | http PATCH 'http://localhost:8080/api/rest/self' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_4"><a class="anchor" href="#_response_body_4"></a><a class="link" href="#_response_body_4">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "remark" : "CbzIG",
  "createAt" : "2023-11-17T19:48:31.37127",
  "updateAt" : "2023-11-17T19:48:31.371277",
  "username" : "TNbOR",
  "name" : "cHyRV",
  "phone" : "13948807383",
  "email" : "7jJSZh5g@ZVoOqM.com",
  "avatar" : "umwInwYffsoKdMTfZmLeyScnrxSFayQfIrGdFcFw",
  "enableState" : "启用",
  "dept" : {
    "id" : "#",
    "parentId" : null,
    "name" : "总公司",
    "idPath" : null,
    "namePath" : null,
    "childIds" : null,
    "createAt" : "2023-11-17T19:48:31.371216",
    "updateAt" : "2023-11-17T19:48:31.371231",
    "type" : "总公司",
    "enableState" : "启用",
    "principal" : "TcJrB",
    "phone" : "139mQsET69H",
    "remark" : "YPypk"
  },
  "role" : {
    "id" : -1,
    "createAt" : "2023-11-17T19:48:31.37125",
    "updateAt" : "2023-11-17T19:48:31.371256",
    "name" : "系统管理员",
    "type" : "自定义",
    "dataScope" : "个人",
    "enableState" : "启用",
    "deptType" : "总公司",
    "authorities" : [ "DEPT_UPDATE", "ROLE_UPDATE", "DEPT_QUERY" ],
    "remark" : "SqWXU"
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="anchor" href="#_request_fields"></a><a class="link" href="#_request_fields">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号.</p>
<p class="tableblock">手机号格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">邮箱.</p>
<p class="tableblock">电子邮箱格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像附件ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_4"><a class="anchor" href="#_response_fields_4"></a><a class="link" href="#_response_fields_4">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-self-update-password"><a class="anchor" href="#resources-self-update-password"></a><a class="link" href="#resources-self-update-password">4.3. Update Password</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/self/update-password</code></p>
</div>
<div class="paragraph">
<p>用户更新自己的密码.</p>
</div>
<div class="sect3">
<h4 id="_example_request_5"><a class="anchor" href="#_example_request_5"></a><a class="link" href="#_example_request_5">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"oldPassword":"JxSFK","password":"JxSFK","passwordRepeat":"JxSFK"}' | http PATCH 'http://localhost:8080/api/rest/self/update-password' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_5"><a class="anchor" href="#_response_body_5"></a><a class="link" href="#_response_body_5">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code></code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="anchor" href="#_request_fields_2"></a><a class="link" href="#_request_fields_2">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">oldPassword</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">旧密码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">password</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">新密码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">passwordRepeat</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">确认密码.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_dept_部门管理"><a class="anchor" href="#_dept_部门管理"></a><a class="link" href="#_dept_部门管理">5. Dept 部门管理</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="resources-dept-all"><a class="anchor" href="#resources-dept-all"></a><a class="link" href="#resources-dept-all">5.1. List</a></h3>
<div class="paragraph">
<p><code>GET /api/rest/dept/all</code></p>
</div>
<div class="paragraph">
<p>返回所有部门列表 hasAuthority('DEPT_QUERY') 适合部门数不多的情况下，返回所有部门，有前端完成查询过滤工作.</p>
</div>
<div class="sect3">
<h4 id="_example_request_6"><a class="anchor" href="#_example_request_6"></a><a class="link" href="#_example_request_6">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http GET 'http://localhost:8080/api/rest/dept/all'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_6"><a class="anchor" href="#_response_body_6"></a><a class="link" href="#_response_body_6">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>[ {
  "id" : "#01",
  "parentId" : "#",
  "name" : "LzFLl",
  "idPath" : null,
  "namePath" : null,
  "childIds" : null,
  "createAt" : "2023-11-17T19:48:29.581274",
  "updateAt" : "2023-11-17T19:48:29.581286",
  "type" : "其它",
  "enableState" : "启用",
  "principal" : "YVeyY",
  "phone" : "139nSBdpcDn",
  "remark" : "NOJUe"
}, {
  "id" : "#02",
  "parentId" : "#",
  "name" : "DbkRx",
  "idPath" : null,
  "namePath" : null,
  "childIds" : null,
  "createAt" : "2023-11-17T19:48:29.581315",
  "updateAt" : "2023-11-17T19:48:29.581321",
  "type" : "其它",
  "enableState" : "启用",
  "principal" : "luZtO",
  "phone" : "139HfMFRZyx",
  "remark" : "ZYkis"
} ]</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_fields_5"><a class="anchor" href="#_response_fields_5"></a><a class="link" href="#_response_fields_5">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-dept-create"><a class="anchor" href="#resources-dept-create"></a><a class="link" href="#resources-dept-create">5.2. Create</a></h3>
<div class="paragraph">
<p><code>POST /api/rest/dept</code></p>
</div>
<div class="paragraph">
<p>新建部门 hasAuthority('DEPT_CREATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_7"><a class="anchor" href="#_example_request_7"></a><a class="link" href="#_example_request_7">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"id":"#01","parentId":"#","name":"LzFLl","type":"其它","principal":"YVeyY","phone":"139nSBdpcDn","remark":"NOJUe"}' | http POST 'http://localhost:8080/api/rest/dept' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_7"><a class="anchor" href="#_response_body_7"></a><a class="link" href="#_response_body_7">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : "#01",
  "parentId" : "#",
  "name" : "LzFLl",
  "idPath" : null,
  "namePath" : null,
  "childIds" : null,
  "createAt" : "2023-11-17T19:48:29.581274",
  "updateAt" : "2023-11-17T19:48:29.581286",
  "type" : "其它",
  "enableState" : "启用",
  "principal" : "YVeyY",
  "phone" : "139nSBdpcDn",
  "remark" : "NOJUe"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="anchor" href="#_request_fields_3"></a><a class="link" href="#_request_fields_3">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父部门ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_6"><a class="anchor" href="#_response_fields_6"></a><a class="link" href="#_response_fields_6">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-dept-update"><a class="anchor" href="#resources-dept-update"></a><a class="link" href="#resources-dept-update">5.3. Update</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/dept/{id}</code></p>
</div>
<div class="paragraph">
<p>更新部门 hasAuthority('DEPT_UPDATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_8"><a class="anchor" href="#_example_request_8"></a><a class="link" href="#_example_request_8">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"name":"LzFLl","type":"其它","principal":"YVeyY","phone":"139nSBdpcDn","remark":"NOJUe"}' | http PATCH 'http://localhost:8080/api/rest/dept/%2301' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_8"><a class="anchor" href="#_response_body_8"></a><a class="link" href="#_response_body_8">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : "#01",
  "parentId" : "#",
  "name" : "LzFLl",
  "idPath" : null,
  "namePath" : null,
  "childIds" : null,
  "createAt" : "2023-11-17T19:48:29.581274",
  "updateAt" : "2023-11-17T19:48:29.581286",
  "type" : "其它",
  "enableState" : "启用",
  "principal" : "YVeyY",
  "phone" : "139nSBdpcDn",
  "remark" : "NOJUe"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_2"><a class="anchor" href="#_path_parameters_2"></a><a class="link" href="#_path_parameters_2">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="anchor" href="#_request_fields_4"></a><a class="link" href="#_request_fields_4">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_7"><a class="anchor" href="#_response_fields_7"></a><a class="link" href="#_response_fields_7">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-dept-toggle"><a class="anchor" href="#resources-dept-toggle"></a><a class="link" href="#resources-dept-toggle">5.4. Toggle</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/dept/{id}/toggle</code></p>
</div>
<div class="paragraph">
<p>切换部门"启动/停用"状态 hasAuthority('DEPT_DELETE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_9"><a class="anchor" href="#_example_request_9"></a><a class="link" href="#_example_request_9">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http PATCH 'http://localhost:8080/api/rest/dept/%2301/toggle'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_9"><a class="anchor" href="#_response_body_9"></a><a class="link" href="#_response_body_9">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : "#01",
  "parentId" : "#",
  "name" : "LzFLl",
  "idPath" : null,
  "namePath" : null,
  "childIds" : null,
  "createAt" : "2023-11-17T19:48:29.581274",
  "updateAt" : "2023-11-17T19:48:29.581286",
  "type" : "其它",
  "enableState" : "启用",
  "principal" : "YVeyY",
  "phone" : "139nSBdpcDn",
  "remark" : "NOJUe"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_3"><a class="anchor" href="#_path_parameters_3"></a><a class="link" href="#_path_parameters_3">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_8"><a class="anchor" href="#_response_fields_8"></a><a class="link" href="#_response_fields_8">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_role_角色管理"><a class="anchor" href="#_role_角色管理"></a><a class="link" href="#_role_角色管理">6. Role 角色管理</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="resources-role-all"><a class="anchor" href="#resources-role-all"></a><a class="link" href="#resources-role-all">6.1. List</a></h3>
<div class="paragraph">
<p><code>GET /api/rest/role/all</code></p>
</div>
<div class="paragraph">
<p>返回所有角色列表 hasAuthority('ROLE_QUERY')</p>
</div>
<div class="sect3">
<h4 id="_example_request_10"><a class="anchor" href="#_example_request_10"></a><a class="link" href="#_example_request_10">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http GET 'http://localhost:8080/api/rest/role/all'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_10"><a class="anchor" href="#_response_body_10"></a><a class="link" href="#_response_body_10">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>[ {
  "id" : -1,
  "createAt" : "2023-11-17T19:48:30.528596",
  "updateAt" : "2023-11-17T19:48:30.528605",
  "name" : "role1",
  "type" : "自定义",
  "dataScope" : "个人",
  "enableState" : "启用",
  "deptType" : "分公司",
  "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
  "remark" : "NeSih"
}, {
  "id" : -1,
  "createAt" : "2023-11-17T19:48:30.528627",
  "updateAt" : "2023-11-17T19:48:30.528632",
  "name" : "role2",
  "type" : "自定义",
  "dataScope" : "个人",
  "enableState" : "启用",
  "deptType" : "分公司",
  "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
  "remark" : "sgCdu"
} ]</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_fields_9"><a class="anchor" href="#_response_fields_9"></a><a class="link" href="#_response_fields_9">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-role-create"><a class="anchor" href="#resources-role-create"></a><a class="link" href="#resources-role-create">6.2. Create</a></h3>
<div class="paragraph">
<p><code>POST /api/rest/role</code></p>
</div>
<div class="paragraph">
<p>新建自定义角色 hasAuthority('ROLE_CREATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_11"><a class="anchor" href="#_example_request_11"></a><a class="link" href="#_example_request_11">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"name":"role1","dataScope":"个人","deptType":"分公司","remark":"NeSih","authorities":["ROLE_CREATE","ROLE_UPDATE"]}' | http POST 'http://localhost:8080/api/rest/role' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_11"><a class="anchor" href="#_response_body_11"></a><a class="link" href="#_response_body_11">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "createAt" : "2023-11-17T19:48:30.528596",
  "updateAt" : "2023-11-17T19:48:30.528605",
  "name" : "role1",
  "type" : "自定义",
  "dataScope" : "个人",
  "enableState" : "启用",
  "deptType" : "分公司",
  "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
  "remark" : "NeSih"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_5"><a class="anchor" href="#_request_fields_5"></a><a class="link" href="#_request_fields_5">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，只能设置系统自定义角色名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限列表.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_10"><a class="anchor" href="#_response_fields_10"></a><a class="link" href="#_response_fields_10">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-role-update"><a class="anchor" href="#resources-role-update"></a><a class="link" href="#resources-role-update">6.3. Update</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/role/{id}</code></p>
</div>
<div class="paragraph">
<p>更新角色 hasAuthority('ROLE_UPDATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_12"><a class="anchor" href="#_example_request_12"></a><a class="link" href="#_example_request_12">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"name":"otherName","dataScope":"个人","deptType":"分公司","remark":"NeSih","authorities":["ROLE_CREATE","ROLE_UPDATE"]}' | http PATCH 'http://localhost:8080/api/rest/role/-1' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_12"><a class="anchor" href="#_response_body_12"></a><a class="link" href="#_response_body_12">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "createAt" : "2023-11-17T19:48:30.528596",
  "updateAt" : "2023-11-17T19:48:30.528605",
  "name" : "role1",
  "type" : "自定义",
  "dataScope" : "个人",
  "enableState" : "启用",
  "deptType" : "分公司",
  "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
  "remark" : "NeSih"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_4"><a class="anchor" href="#_path_parameters_4"></a><a class="link" href="#_path_parameters_4">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_request_fields_6"><a class="anchor" href="#_request_fields_6"></a><a class="link" href="#_request_fields_6">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，只能设置系统自定义角色名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限列表.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_11"><a class="anchor" href="#_response_fields_11"></a><a class="link" href="#_response_fields_11">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-role-toggle"><a class="anchor" href="#resources-role-toggle"></a><a class="link" href="#resources-role-toggle">6.4. Toggle</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/role/{id}/toggle</code></p>
</div>
<div class="paragraph">
<p>切换角色"启动/禁用"状态 hasAuthority('ROLE_DELETE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_13"><a class="anchor" href="#_example_request_13"></a><a class="link" href="#_example_request_13">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http PATCH 'http://localhost:8080/api/rest/role/-1/toggle'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_13"><a class="anchor" href="#_response_body_13"></a><a class="link" href="#_response_body_13">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "createAt" : "2023-11-17T19:48:30.528596",
  "updateAt" : "2023-11-17T19:48:30.528605",
  "name" : "role1",
  "type" : "自定义",
  "dataScope" : "个人",
  "enableState" : "启用",
  "deptType" : "分公司",
  "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
  "remark" : "NeSih"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_5"><a class="anchor" href="#_path_parameters_5"></a><a class="link" href="#_path_parameters_5">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_12"><a class="anchor" href="#_response_fields_12"></a><a class="link" href="#_response_fields_12">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_user_用户管理"><a class="anchor" href="#_user_用户管理"></a><a class="link" href="#_user_用户管理">7. User 用户管理</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="resources-user-query"><a class="anchor" href="#resources-user-query"></a><a class="link" href="#resources-user-query">7.1. Page</a></h3>
<div class="paragraph">
<p><code>GET /api/rest/user</code></p>
</div>
<div class="paragraph">
<p>分页查询用户信息 hasAuthority('USER_QUERY')</p>
</div>
<div class="sect3">
<h4 id="_example_request_14"><a class="anchor" href="#_example_request_14"></a><a class="link" href="#_example_request_14">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http GET 'http://localhost:8080/api/rest/user?username=001&amp;name=%E7%AE%A1%E7%90%86%E5%91%98&amp;phone=13415363421&amp;email=RgSjLawf%403trNDj.com&amp;enableState=%E5%90%AF%E7%94%A8&amp;roleIds=-1&amp;deptIds=%23'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_14"><a class="anchor" href="#_response_body_14"></a><a class="link" href="#_response_body_14">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "content" : [ {
    "id" : -1,
    "remark" : "xSEgy",
    "createAt" : "2023-11-17T19:48:25.284919",
    "updateAt" : "2023-11-17T19:48:25.284925",
    "username" : "001",
    "name" : "管理员",
    "phone" : "13415363421",
    "email" : "RgSjLawf@3trNDj.com",
    "avatar" : "skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW",
    "enableState" : "启用",
    "dept" : {
      "id" : "#",
      "parentId" : null,
      "name" : "LXXMD",
      "idPath" : null,
      "namePath" : null,
      "childIds" : null,
      "createAt" : "2023-11-17T19:48:25.28488",
      "updateAt" : "2023-11-17T19:48:25.284888",
      "type" : "其它",
      "enableState" : "启用",
      "principal" : "sGJLk",
      "phone" : "139bCG82EtU",
      "remark" : "moKQo"
    },
    "role" : {
      "id" : -1,
      "createAt" : "2023-11-17T19:48:25.284816",
      "updateAt" : "2023-11-17T19:48:25.284829",
      "name" : "role1",
      "type" : "自定义",
      "dataScope" : "个人",
      "enableState" : "启用",
      "deptType" : "分公司",
      "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
      "remark" : "UZJiQ"
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "pageNumber" : 0,
    "pageSize" : 10,
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "totalElements" : 1,
  "totalPages" : 1,
  "last" : true,
  "numberOfElements" : 1,
  "size" : 10,
  "number" : 0,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "empty" : false
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_query_parameters_2"><a class="anchor" href="#_query_parameters_2"></a><a class="link" href="#_query_parameters_2">Query parameters</a></h4>
<div class="paragraph">
<p>Supports standard <a href="#overview-pagination">paging</a> query parameters.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、员工编号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名，模糊查询.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">roleIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Integer]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色集合.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门集合.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_13"><a class="anchor" href="#_response_fields_13"></a><a class="link" href="#_response_fields_13">Response fields</a></h4>
<div class="paragraph">
<p>Standard <a href="#overview-pagination">paging</a> response where <code>content</code> field is list of following objects:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-user-create"><a class="anchor" href="#resources-user-create"></a><a class="link" href="#resources-user-create">7.2. Create</a></h3>
<div class="paragraph">
<p><code>POST /api/rest/user/</code></p>
</div>
<div class="paragraph">
<p>新建用户 hasAuthority('USER_CREATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_15"><a class="anchor" href="#_example_request_15"></a><a class="link" href="#_example_request_15">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"username":"001","name":"管理员","password":"DxOXp","phone":"13415363421","email":"RgSjLawf@3trNDj.com","avatar":"skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW","deptId":"#","roleId":-1,"remark":"xSEgy"}' | http POST 'http://localhost:8080/api/rest/user/' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_15"><a class="anchor" href="#_response_body_15"></a><a class="link" href="#_response_body_15">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "remark" : "xSEgy",
  "createAt" : "2023-11-17T19:48:25.284919",
  "updateAt" : "2023-11-17T19:48:25.284925",
  "username" : "001",
  "name" : "管理员",
  "phone" : "13415363421",
  "email" : "RgSjLawf@3trNDj.com",
  "avatar" : "skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW",
  "enableState" : "启用",
  "dept" : {
    "id" : "#",
    "parentId" : null,
    "name" : "LXXMD",
    "idPath" : null,
    "namePath" : null,
    "childIds" : null,
    "createAt" : "2023-11-17T19:48:25.28488",
    "updateAt" : "2023-11-17T19:48:25.284888",
    "type" : "其它",
    "enableState" : "启用",
    "principal" : "sGJLk",
    "phone" : "139bCG82EtU",
    "remark" : "moKQo"
  },
  "role" : {
    "id" : -1,
    "createAt" : "2023-11-17T19:48:25.284816",
    "updateAt" : "2023-11-17T19:48:25.284829",
    "name" : "role1",
    "type" : "自定义",
    "dataScope" : "个人",
    "enableState" : "启用",
    "deptType" : "分公司",
    "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
    "remark" : "UZJiQ"
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_7"><a class="anchor" href="#_request_fields_7"></a><a class="link" href="#_request_fields_7">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名，学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">password</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">密码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号.</p>
<p class="tableblock">手机号格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">邮箱.</p>
<p class="tableblock">电子邮箱格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像附件ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">roleId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_14"><a class="anchor" href="#_response_fields_14"></a><a class="link" href="#_response_fields_14">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-user-update"><a class="anchor" href="#resources-user-update"></a><a class="link" href="#resources-user-update">7.3. Update</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/user/{id}</code></p>
</div>
<div class="paragraph">
<p>更新用户 hasAuthority('USER_UPDATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_16"><a class="anchor" href="#_example_request_16"></a><a class="link" href="#_example_request_16">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"username":"001","name":"管理员","phone":"13415363421","email":"RgSjLawf@3trNDj.com","avatar":"skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW","deptId":"#","roleId":-1,"remark":"xSEgy"}' | http PATCH 'http://localhost:8080/api/rest/user/-1' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_16"><a class="anchor" href="#_response_body_16"></a><a class="link" href="#_response_body_16">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "remark" : "xSEgy",
  "createAt" : "2023-11-17T19:48:25.284919",
  "updateAt" : "2023-11-17T19:48:25.284925",
  "username" : "001",
  "name" : "管理员",
  "phone" : "13415363421",
  "email" : "RgSjLawf@3trNDj.com",
  "avatar" : "skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW",
  "enableState" : "启用",
  "dept" : {
    "id" : "#",
    "parentId" : null,
    "name" : "LXXMD",
    "idPath" : null,
    "namePath" : null,
    "childIds" : null,
    "createAt" : "2023-11-17T19:48:25.28488",
    "updateAt" : "2023-11-17T19:48:25.284888",
    "type" : "其它",
    "enableState" : "启用",
    "principal" : "sGJLk",
    "phone" : "139bCG82EtU",
    "remark" : "moKQo"
  },
  "role" : {
    "id" : -1,
    "createAt" : "2023-11-17T19:48:25.284816",
    "updateAt" : "2023-11-17T19:48:25.284829",
    "name" : "role1",
    "type" : "自定义",
    "dataScope" : "个人",
    "enableState" : "启用",
    "deptType" : "分公司",
    "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
    "remark" : "UZJiQ"
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_6"><a class="anchor" href="#_path_parameters_6"></a><a class="link" href="#_path_parameters_6">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_request_fields_8"><a class="anchor" href="#_request_fields_8"></a><a class="link" href="#_request_fields_8">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名，学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号.</p>
<p class="tableblock">手机号格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">邮箱.</p>
<p class="tableblock">电子邮箱格式不对.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像附件ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">deptId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">roleId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_15"><a class="anchor" href="#_response_fields_15"></a><a class="link" href="#_response_fields_15">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-user-update-password"><a class="anchor" href="#resources-user-update-password"></a><a class="link" href="#resources-user-update-password">7.4. Update Password</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/user/{id}/update-password</code></p>
</div>
<div class="paragraph">
<p>更新用户密码 hasAuthority('USER_UPDATE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_17"><a class="anchor" href="#_example_request_17"></a><a class="link" href="#_example_request_17">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ echo '{"password":"Nxuhg","passwordRepeat":"Nxuhg"}' | http PATCH 'http://localhost:8080/api/rest/user/-1/update-password' \
    'Content-Type:application/json;charset=UTF-8'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_17"><a class="anchor" href="#_response_body_17"></a><a class="link" href="#_response_body_17">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code></code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_7"><a class="anchor" href="#_path_parameters_7"></a><a class="link" href="#_path_parameters_7">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_request_fields_9"><a class="anchor" href="#_request_fields_9"></a><a class="link" href="#_request_fields_9">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">password</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">新密码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">passwordRepeat</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">确认密码.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="resources-user-toggle"><a class="anchor" href="#resources-user-toggle"></a><a class="link" href="#resources-user-toggle">7.5. Toggle</a></h3>
<div class="paragraph">
<p><code>PATCH /api/rest/user/{id}/toggle</code></p>
</div>
<div class="paragraph">
<p>切换用户"启动/禁用"状态 hasAuthority('USER_DELETE')</p>
</div>
<div class="sect3">
<h4 id="_example_request_18"><a class="anchor" href="#_example_request_18"></a><a class="link" href="#_example_request_18">Example request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ http PATCH 'http://localhost:8080/api/rest/user/-1/toggle'</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_body_18"><a class="anchor" href="#_response_body_18"></a><a class="link" href="#_response_body_18">Response Body</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>{
  "id" : -1,
  "remark" : "xSEgy",
  "createAt" : "2023-11-17T19:48:25.284919",
  "updateAt" : "2023-11-17T19:48:25.284925",
  "username" : "001",
  "name" : "管理员",
  "phone" : "13415363421",
  "email" : "RgSjLawf@3trNDj.com",
  "avatar" : "skDhVJXXrSzXMsGMYslfAYBLlCBqBEIzKopeuOxW",
  "enableState" : "启用",
  "dept" : {
    "id" : "#",
    "parentId" : null,
    "name" : "LXXMD",
    "idPath" : null,
    "namePath" : null,
    "childIds" : null,
    "createAt" : "2023-11-17T19:48:25.28488",
    "updateAt" : "2023-11-17T19:48:25.284888",
    "type" : "其它",
    "enableState" : "启用",
    "principal" : "sGJLk",
    "phone" : "139bCG82EtU",
    "remark" : "moKQo"
  },
  "role" : {
    "id" : -1,
    "createAt" : "2023-11-17T19:48:25.284816",
    "updateAt" : "2023-11-17T19:48:25.284829",
    "name" : "role1",
    "type" : "自定义",
    "dataScope" : "个人",
    "enableState" : "启用",
    "deptType" : "分公司",
    "authorities" : [ "ROLE_CREATE", "ROLE_UPDATE" ],
    "remark" : "UZJiQ"
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_path_parameters_8"><a class="anchor" href="#_path_parameters_8"></a><a class="link" href="#_path_parameters_8">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_response_fields_16"><a class="anchor" href="#_response_fields_16"></a><a class="link" href="#_response_fields_16">Response fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Optional</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户名、学号.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">姓名.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">手机号码.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">email</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">电子邮件.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">avatar</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">头像图片链接.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID主键，根节点的编号为# 遵循一定规律的编号，如parentId是#01，这id必须以#01为前缀.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.parentId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">父节点ID.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.idPath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ID路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点ID组成的字符串，以"/"为分隔符 例如：#/#01/#0101.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.namePath</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name路径，不存入数据库 由根节点开始，一直到本节点，该路径所有节点Name组成的字符串，以"/"为分隔符 例如：总公司/分公司1/部门1.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.childIds</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">子节点ID集合，以ID排序，不存入数据库.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.principal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">部门负责人.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.phone</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">联系电话.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">dept.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色权限.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">自增主键.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.createAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.updateAt</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新时间.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">名称，系统内置角色的名称和类型一致.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.type</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色类型，除自定义之外，都是系统内置角色.</p>
<p class="tableblock">Must be one of [自定义, 系统管理员, 部门经理, 业务员].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.dataScope</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">数据访问范围.</p>
<p class="tableblock">Must be one of [全局, 部门, 个人].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.enableState</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">启用状态.</p>
<p class="tableblock">Must be one of [启用, 停用].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.deptType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">所属部门类型.</p>
<p class="tableblock">Must be one of [总公司, 分公司, 业务部门, 其它].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.authorities</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Array[String]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限集合.</p>
<p class="tableblock">Must be one of [DEPT_QUERY, DEPT_CREATE, DEPT_UPDATE, DEPT_DELETE, ROLE_QUERY, ROLE_CREATE, ROLE_UPDATE, ROLE_DELETE, USER_QUERY, USER_CREATE, USER_UPDATE, USER_DELETE].</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">role.remark</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">备注说明.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-11-17 14:58:25 CST
</div>
</div>
</body>
</html>